﻿<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <link rel="stylesheet" href="../assets/css/yui-cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/x-icon" href="../assets/favicon.ico">
    <script src="../assets/js/yui-source.js"></script>
	<title>EaselJS v1.0.0 API Documentation : ButtonHelper</title>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><a href="http://createjs.site/easeljs"><img src="../assets/docs-icon-EaselJS.png" title="EaselJS"></a></h1>
            
        </div>
        <div class="version">
            <em>API Documentation for: 1.0.0</em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="AlphaMapFilter.html">AlphaMapFilter</a></li>
            
                <li><a href="AlphaMaskFilter.html">AlphaMaskFilter</a></li>
            
                <li><a href="Bitmap.html">Bitmap</a></li>
            
                <li><a href="BitmapCache.html">BitmapCache</a></li>
            
                <li><a href="BitmapText.html">BitmapText</a></li>
            
                <li><a href="BlurFilter.html">BlurFilter</a></li>
            
                <li><a href="ButtonHelper.html">ButtonHelper</a></li>
            
                <li><a href="ColorFilter.html">ColorFilter</a></li>
            
                <li><a href="ColorMatrix.html">ColorMatrix</a></li>
            
                <li><a href="ColorMatrixFilter.html">ColorMatrixFilter</a></li>
            
                <li><a href="Container.html">Container</a></li>
            
                <li><a href="DisplayObject.html">DisplayObject</a></li>
            
                <li><a href="DisplayProps.html">DisplayProps</a></li>
            
                <li><a href="DOMElement.html">DOMElement</a></li>
            
                <li><a href="EaselJS.html">EaselJS</a></li>
            
                <li><a href="Event.html">Event</a></li>
            
                <li><a href="EventDispatcher.html">EventDispatcher</a></li>
            
                <li><a href="Filter.html">Filter</a></li>
            
                <li><a href="Graphics.html">Graphics</a></li>
            
                <li><a href="Graphics.Arc.html">Graphics.Arc</a></li>
            
                <li><a href="Graphics.ArcTo.html">Graphics.ArcTo</a></li>
            
                <li><a href="Graphics.BeginPath.html">Graphics.BeginPath</a></li>
            
                <li><a href="Graphics.BezierCurveTo.html">Graphics.BezierCurveTo</a></li>
            
                <li><a href="Graphics.Circle.html">Graphics.Circle</a></li>
            
                <li><a href="Graphics.ClosePath.html">Graphics.ClosePath</a></li>
            
                <li><a href="Graphics.Ellipse.html">Graphics.Ellipse</a></li>
            
                <li><a href="Graphics.Fill.html">Graphics.Fill</a></li>
            
                <li><a href="Graphics.LineTo.html">Graphics.LineTo</a></li>
            
                <li><a href="Graphics.MoveTo.html">Graphics.MoveTo</a></li>
            
                <li><a href="Graphics.PolyStar.html">Graphics.PolyStar</a></li>
            
                <li><a href="Graphics.QuadraticCurveTo.html">Graphics.QuadraticCurveTo</a></li>
            
                <li><a href="Graphics.Rect.html">Graphics.Rect</a></li>
            
                <li><a href="Graphics.RoundRect.html">Graphics.RoundRect</a></li>
            
                <li><a href="Graphics.Stroke.html">Graphics.Stroke</a></li>
            
                <li><a href="Graphics.StrokeDash.html">Graphics.StrokeDash</a></li>
            
                <li><a href="Graphics.StrokeStyle.html">Graphics.StrokeStyle</a></li>
            
                <li><a href="Matrix2D.html">Matrix2D</a></li>
            
                <li><a href="MouseEvent.html">MouseEvent</a></li>
            
                <li><a href="MovieClip.html">MovieClip</a></li>
            
                <li><a href="MovieClipPlugin.html">MovieClipPlugin</a></li>
            
                <li><a href="Point.html">Point</a></li>
            
                <li><a href="Rectangle.html">Rectangle</a></li>
            
                <li><a href="Shadow.html">Shadow</a></li>
            
                <li><a href="Shape.html">Shape</a></li>
            
                <li><a href="Sprite.html">Sprite</a></li>
            
                <li><a href="SpriteSheet.html">SpriteSheet</a></li>
            
                <li><a href="SpriteSheetBuilder.html">SpriteSheetBuilder</a></li>
            
                <li><a href="SpriteSheetUtils.html">SpriteSheetUtils</a></li>
            
                <li><a href="Stage.html">Stage</a></li>
            
                <li><a href="StageGL.html">StageGL</a></li>
            
                <li><a href="Text.html">Text</a></li>
            
                <li><a href="Ticker.html">Ticker</a></li>
            
                <li><a href="Touch.html">Touch</a></li>
            
                <li><a href="UID.html">UID</a></li>
            
                <li><a href="Utility%20Methods.html">Utility Methods</a></li>
            
                <li><a href="VideoBuffer.html">VideoBuffer</a></li>
            
                <li><a href="WebGLInspector.html">WebGLInspector</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="../modules/CreateJS.html">CreateJS</a></li>
            
                <li><a href="../modules/EaselJS.html">EaselJS</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
            <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked="">
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1>ButtonHelper Class</h1>
<div class="box meta">
    

    

    
        <div class="foundat">
            Defined in: <a href="../files/easeljs_ui_ButtonHelper.js.html#l41"><code>ButtonHelper:41</code></a>
        </div>
    

    
        
            Module: <a href="../modules/EaselJS.html">EaselJS</a>
        
    

    
</div>



<div class="box intro">
    <p>ButtonHelper是一个帮助类，用于从 <a href="MovieClip.html" class="crosslink">MovieClip</a> 或
<a href="Sprite.html" class="crosslink">Sprite</a> 实例创建交互式按钮。该类将截获对象的鼠标事件，并自动调用
 <a href="Sprite.html#method_gotoAndStop" class="crosslink">gotoAndStop</a> 或 <a href="Sprite.html#method_gotoAndPlay" class="crosslink">gotoAndPlay</a>
 到相应的动画标签，添加指针光标，并允许用户定义命中状态帧。</p>
<p>ButtonHelper实例不需要添加到阶段，但应保留引用以防止垃圾收集。</p>
<p>Note that over states will not work unless you call <a href="Stage.html#method_enableMouseOver" class="crosslink">enableMouseOver</a>.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> var helper = new createjs.ButtonHelper(myInstance, "out", "over", "down", false, myInstance, "hit");
 myInstance.addEventListener("click", handleClick);
 function handleClick(event) {
     // Click Happened.
 }</code></pre>

</div>


    <div class="constructor">
        <h2>Constructor</h2>
        <div id="method_ButtonHelper" class="method item">
    <h3 class="name"><code>ButtonHelper</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>target</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[outLabel=&quot;out&quot;]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[overLabel=&quot;over&quot;]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[downLabel=&quot;down&quot;]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[play=false]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[hitArea]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[hitLabel]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l41"><code>ButtonHelper:41</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">target</code>
                        <span class="type"><a href="Sprite.html" class="crosslink">Sprite</a> | <a href="MovieClip.html" class="crosslink">MovieClip</a></span>
                    

                    

                    <div class="param-description">
                        <p>The instance to manage.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[outLabel=&quot;out&quot;]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The label or animation to go to when the user rolls out of the button.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[overLabel=&quot;over&quot;]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The label or animation to go to when the user rolls over the button.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[downLabel=&quot;down&quot;]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The label or animation to go to when the user presses the button.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[play=false]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>If the helper should call "gotoAndPlay" or "gotoAndStop" on the button when changing
states.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[hitArea]</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>An optional item to use as the hit state for the button. If this is not defined,
then the button&#39;s visible states will be used instead. Note that the same instance as the "target" argument can be
used for the hitState.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[hitLabel]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The label or animation on the hitArea instance that defines the hitArea bounds. If this is
null, then the default state of the hitArea will be used. *</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

    </div>


<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

        
            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
        
        
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
        
        
        
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

            
                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                        
                            <li class="index-item method protected">
                                <a href="#method__reset">_reset</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method_getEnabled">getEnabled</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_getEnabled">getEnabled</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method_handleEvent">handleEvent</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method_setEnabled">setEnabled</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_setEnabled">setEnabled</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_toString">toString</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            
                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties">
                        
                            <li class="index-item property protected">
                                <a href="#property__enabled">_enabled</a>

                                
                                
                            </li>
                        
                            <li class="index-item property protected">
                                <a href="#property__isOver">_isOver</a>

                                
                                
                            </li>
                        
                            <li class="index-item property protected">
                                <a href="#property__isPressed">_isPressed</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_downLabel">downLabel</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_enabled">enabled</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_outLabel">outLabel</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_overLabel">overLabel</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_play">play</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_target">target</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            

            
        </div>

        
            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

                
                    <div id="method__reset" class="method item protected">
    <h3 class="name"><code>_reset</code></h3>

    
        <span class="paren">()</span>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l259"><code>_reset:259</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Injected into target. Preserves the paused state through a reset.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_getEnabled" class="method item protected">
    <h3 class="name"><code>getEnabled</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l190"><code>getEnabled:190</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="ButtonHelper.html#property_enabled" class="crosslink">enabled</a> property instead.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getEnabled" class="method item deprecated">
    <h3 class="name"><code>getEnabled</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l200"><code>getEnabled:200</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="ButtonHelper.html#property_enabled" class="crosslink">enabled</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_handleEvent" class="method item protected">
    <h3 class="name"><code>handleEvent</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>evt</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l232"><code>handleEvent:232</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">evt</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The mouse event to handle.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_setEnabled" class="method item protected">
    <h3 class="name"><code>setEnabled</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>value</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l154"><code>setEnabled:154</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="ButtonHelper.html#property_enabled" class="crosslink">enabled</a> property instead.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">value</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    

                    

                    <div class="param-description">
                        <p>The enabled property to set the instance to.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_setEnabled" class="method item deprecated">
    <h3 class="name"><code>setEnabled</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l182"><code>setEnabled:182</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="ButtonHelper.html#property_enabled" class="crosslink">enabled</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_toString" class="method item">
    <h3 class="name"><code>toString</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l221"><code>toString:221</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns a string representation of this object.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    
                    <p>a string representation of the instance.</p>

                
            </div>
        </div>
    

    
</div>

                
            </div>
        

        
            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

                
                    <div id="property__enabled" class="property item protected">
    <h3 class="name"><code>_enabled</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l132"><code>_enabled:132</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

                
                    <div id="property__isOver" class="property item protected">
    <h3 class="name"><code>_isOver</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l125"><code>_isOver:125</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

                
                    <div id="property__isPressed" class="property item protected">
    <h3 class="name"><code>_isPressed</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l118"><code>_isPressed:118</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

                
                    <div id="property_downLabel" class="property item">
    <h3 class="name"><code>downLabel</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l101"><code>downLabel:101</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The label name or frame number to display when the user presses on the target. Defaults to "down".</p>

    </div>

    

    

    
</div>

                
                    <div id="property_enabled" class="property item">
    <h3 class="name"><code>enabled</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l208"><code>enabled:208</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Enables or disables the button functionality on the target.</p>

    </div>

    

    

    
</div>

                
                    <div id="property_outLabel" class="property item">
    <h3 class="name"><code>outLabel</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l94"><code>outLabel:94</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The label name or frame number to display when the user mouses over the target. Defaults to "out".</p>

    </div>

    

    

    
</div>

                
                    <div id="property_overLabel" class="property item">
    <h3 class="name"><code>overLabel</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l87"><code>overLabel:87</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The label name or frame number to display when the user mouses out of the target. Defaults to "over".</p>

    </div>

    

    

    
</div>

                
                    <div id="property_play" class="property item">
    <h3 class="name"><code>play</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l108"><code>play:108</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>If true, then ButtonHelper will call gotoAndPlay, if false, it will use gotoAndStop. Default is false.</p>

    </div>

    
        <p><strong>Default:</strong> false</p>
    

    

    
</div>

                
                    <div id="property_target" class="property item">
    <h3 class="name"><code>target</code></h3>
    <span class="type"><a href="MovieClip.html" class="crosslink">MovieClip</a> | <a href="Sprite.html" class="crosslink">Sprite</a></span>

    

    

    

    

    
        <span class="flag readonly">readonly</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_ui_ButtonHelper.js.html#l79"><code>target:79</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The target for this button helper.</p>

    </div>

    

    

    
</div>

                
            </div>
        

        

        
    </div>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
